<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Welcome to Golem&#8217;s documentation! &mdash; Golem v1.0 documentation</title>
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
          URL_ROOT:    '',
          VERSION:     '1.0',
          COLLAPSE_MODINDEX: false,
          FILE_SUFFIX: ''
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/interface.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="contents" title="Global table of contents" href="contents.html" />
    <link rel="index" title="Global index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="top" title="Golem v1.0 documentation" href="" />
    <link rel="next" title="An overview of Golem" href="overview.html" />
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="modindex.html" title="Global Module Index"
             accesskey="M">modules</a> |</li>
        <li class="right" >
          <a href="overview.html" title="An overview of Golem"
             accesskey="N">next</a> |</li>
        <li><a href="">Golem v1.0 documentation</a> &raquo;</li>
      </ul>
    </div>
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  
  <div class="section" id="welcome-to-golem-s-documentation">
<h1 id="welcome-to-golem-s-documentation">Welcome to Golem&#8217;s documentation!<a class="headerlink" href="#welcome-to-golem-s-documentation" title="Permalink to this headline">¶</a></h1>
<ul>
<li><a class="reference external" href="overview.html">An overview of Golem</a><ul>
<li><a class="reference external" href="overview.html#what-is-golem">What is Golem?</a></li>
<li><a class="reference external" href="overview.html#who-and-what-uses-golem">Who (and what) uses Golem?</a></li>
<li><a class="reference external" href="overview.html#what-problem-does-golem-solve">What problem does Golem solve?</a></li>
<li><a class="reference external" href="overview.html#codes-and-resources-with-golem-dictionaries">Codes and resources with Golem dictionaries</a></li>
<li><a class="reference external" href="overview.html#how-can-i-get-started">How can I get started?</a></li>
</ul>
</li>
</ul>
<ul>
<li><a class="reference external" href="install.html">Installing Golem</a><ul>
<li><a class="reference external" href="install.html#prerequisites">Prerequisites</a></li>
<li><a class="reference external" href="install.html#installation">Installation</a></li>
</ul>
</li>
</ul>
<ul>
<li><a class="reference external" href="summon.html">Summon</a><ul>
<li><a class="reference external" href="summon.html#installing-summon">Installing Summon</a></li>
<li><a class="reference external" href="summon.html#note-for-windows-users">Note for Windows users</a></li>
<li><a class="reference external" href="summon.html#using-summon">Using Summon</a></li>
<li><a class="reference external" href="summon.html#routing-output">Routing output</a></li>
<li><a class="reference external" href="summon.html#summon-configuration-files">Summon configuration files</a></li>
</ul>
</li>
</ul>
<ul>
<li><a class="reference external" href="makingdictionaries.html">Developing CML/Golem dictionaries</a><ul>
<li><a class="reference external" href="makingdictionaries.html#adding-cml-markup-to-your-code">Adding CML markup to your code</a></li>
<li><a class="reference external" href="makingdictionaries.html#producing-a-cml-golem-dictionary">Producing a CML/Golem dictionary</a></li>
</ul>
</li>
</ul>
<ul>
<li><a class="reference external" href="dictionarysyntax.html">CML/Golem dictionary syntax</a><ul>
<li><a class="reference external" href="dictionarysyntax.html#definition-and-description"><tt class="docutils literal"><span class="pre">&lt;definition&gt;</span></tt> and <tt class="docutils literal"><span class="pre">&lt;description&gt;</span></tt></a></li>
<li><a class="reference external" href="dictionarysyntax.html#golem-xpath"><tt class="docutils literal"><span class="pre">&lt;golem:xpath&gt;</span></tt></a></li>
<li><a class="reference external" href="dictionarysyntax.html#golem-template"><tt class="docutils literal"><span class="pre">&lt;golem:template&gt;</span></tt></a></li>
<li><a class="reference external" href="dictionarysyntax.html#golem-synonym-et-al"><tt class="docutils literal"><span class="pre">&lt;golem:synonym&gt;</span></tt> et al</a></li>
<li><a class="reference external" href="dictionarysyntax.html#golem-possiblevalues"><tt class="docutils literal"><span class="pre">&lt;golem:possibleValues&gt;</span></tt></a></li>
</ul>
</li>
</ul>
<ul>
<li><a class="reference external" href="usinglibrary.html">Using the Golem library</a><ul>
<li><a class="reference external" href="usinglibrary.html#importing-golem-and-loading-a-dictionary">Importing Golem and loading a dictionary</a></li>
<li><a class="reference external" href="usinglibrary.html#loading-a-dictionary-and-looking-up-terms">Loading a dictionary and looking up terms</a></li>
</ul>
</li>
</ul>
<ul>
<li><a class="reference external" href="examples.html">Golem examples</a><ul>
<li><a class="reference external" href="examples.html#reading-some-data">Reading some data</a></li>
<li><a class="reference external" href="examples.html#dealing-with-multiple-return-values">Dealing with multiple return values</a></li>
<li><a class="reference external" href="examples.html#terms-with-no-template">Terms with no template</a></li>
<li><a class="reference external" href="examples.html#converting-entire-document-sections">Converting entire document sections</a></li>
</ul>
</li>
</ul>
<ul>
<li><a class="reference external" href="apidoc.html">Golem API documentation</a><ul>
<li><a class="reference external" href="apidoc.html#module-golem">golem</a></li>
<li><a class="reference external" href="apidoc.html#module-golem.helpers">golem.helpers</a></li>
<li><a class="reference external" href="apidoc.html#module-golem.db">golem.db</a></li>
</ul>
</li>
</ul>
<ul>
<li><a class="reference external" href="colophon.html">Colophon</a><ul>
<li><a class="reference external" href="colophon.html#license">License</a></li>
<li><a class="reference external" href="colophon.html#materialsgrid">MaterialsGrid</a></li>
<li><a class="reference external" href="colophon.html#release-history">Release history</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="indices-and-tables">
<h1 id="indices-and-tables">Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference external" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference external" href="modindex.html"><em>Module Index</em></a></li>
<li><a class="reference external" href="search.html"><em>Search Page</em></a></li>
</ul>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <h3>Table Of Contents</h3>
            <ul>
<li><a class="reference external" href="">Welcome to Golem&#8217;s documentation!</a><ul>
</ul>
</li>
<li><a class="reference external" href="#indices-and-tables">Indices and tables</a></li>
</ul>

            <h4>Next topic</h4>
            <p class="topless"><a href="overview.html" title="next chapter">An overview of Golem</a></p>
            <h3>This Page</h3>
            <ul class="this-page-menu">
              <li><a href="_sources/index.txt">Show Source</a></li>
            </ul>
            <h3>Quick search</h3>
            <form class="search" action="search.html" method="get">
              <input type="text" name="q" size="18" /> <input type="submit" value="Go" />
              <input type="hidden" name="check_keywords" value="yes" />
              <input type="hidden" name="area" value="default" />
            </form>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="modindex.html" title="Global Module Index"
             accesskey="M">modules</a> |</li>
        <li class="right" >
          <a href="overview.html" title="An overview of Golem"
             accesskey="N">next</a> |</li>
        <li><a href="">Golem v1.0 documentation</a> &raquo;</li>
      </ul>
    </div>
    <div class="footer">
      &copy; Copyright 2008, Andrew Walkingshaw.
      Last updated on Oct 01, 2008.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
    </div>
  </body>
</html>